home *** CD-ROM | disk | FTP | other *** search
/ By Popular Request 2.0 / By Popular Request 2.0 (Arsenal Computer).ISO / amiga_4 / jm940317.lha / JAMSCAN.DOC < prev    next >
Text File  |  1994-03-17  |  8KB  |  210 lines
  1.  
  2.  
  3.                          -==* JamScan 0.58 *==-
  4.                            By James McOrmond
  5.  
  6.                             March 17th, 1994
  7.  
  8.  
  9.  
  10.  
  11.  
  12. What is JamScan?
  13.  
  14. JamScan is a complete replacement for JBundle, an Arexx script I wrote
  15. last year, to bundle up uncompressed packets of mail, and to add them
  16. to Xferq.library to be sent out during a session.
  17.  
  18. JamScan does more than JBundle ever did, and it also does it much faster!
  19.  
  20. (JamScan is also pure for those of you that want things as fast as
  21. possible and like to make things resident)
  22.  
  23. The reason I wrote JamScan at this time, is that with the release of
  24. JamMail, I figured people would want a relatively fast and easy to use
  25. program that will fix up the files in their outbound directory.
  26.  
  27. Note: JamScan, and most Jam* utilities, all require AmigaDos2.0 or greater.
  28.  
  29.  
  30. How does it work?
  31.  
  32. When you run JamScan, it will check for an Env: variable named "JAMSCAN"
  33. and if it exists, it will use the contents as the filename for the config
  34. file.  If no ENV: variable exists, the default is Mail:JamScan.cfg.
  35.  
  36. After reading the config file, it will scan your packets directory for
  37. files that fit any of your route patterns.  If the filename fits the
  38. pattern "#?.?ut", it will compress the packet into a bundle that already
  39. exists for that system, or it will create a new bundle.
  40.  
  41. If it finds a bundle in the outbound directory, it will make sure that
  42. the file is being sent to that system (if your tosser already does the
  43. archiving, this is what you'll likely be using).  This method is not as
  44. safe as the first option, but it is required until more tossers are
  45. Xferq.Library aware.
  46.  
  47. The priority that these files are sent with is configured one of two ways.
  48. If you specify "Hold", "Crash", or "Direct", the file will have the the
  49. priority that the specific type has (Defaults are: -50 for hold, +30 for
  50. direct and +50 for crash).  If this is a bundle that JamScan is just
  51. trying to add to Xferq a setting of "Norm" will result in a priority of
  52. 0.  If this is a Bundle that JamScan has just added a packet to, it will
  53. check the 3rd last character in the origional filename and set the
  54. priority appropriate to that character.  (C=Crash, D=Direct, H=Hold).
  55.  
  56.  
  57.  
  58. How Do I install JamScan?
  59.  
  60. JamScan is very easy to install.  There are really only two relevent
  61. files.  The JamScan binary itself should be put somewhere in your search
  62. path.  If you have a directory where Networking software goes, this is
  63. likely a good place.  The other file is your config file.  I myself have
  64. the config file in my Mail: directory, but you can locate it wherever you
  65. wish.  If your config file is not Mail:JamScan.cfg, you need to specify
  66. the full path name to get to your config file in the JamScan Environment
  67. variable.
  68.  
  69.  
  70.  
  71. Configuring JamScan:
  72.  
  73. There are 8 different commands that JamScan understands in its config
  74. file.  They are as follows:
  75.  
  76. HOST    - Your Host address
  77. HOLD    - The default Priority for "Hold" mail
  78. DIRECT  - The default Priority for "Direct" mail
  79. CRASH   - The default priority for "Crash" mail
  80. BUNDLES - The Directory Bundles will be placed
  81. PACKETS - The directory Packets will be searched for
  82. PKTS    - The directory temporary compression directories will be made
  83. ROUTE   - The actual Routing command.
  84.  
  85.  
  86. The "Packets" and the "Pkts" directories must be on the same device.  I
  87. have placed the Pkts directory as a Sub-directory in the Packets
  88. directory, you may wish to do the same.
  89.  
  90. The only keyword that is absolutely required is at least one ROUTE
  91. keyword.  Without any ROUTE lines, JamScan won't do anything.
  92.  
  93.  
  94.  
  95. How do I setup a Route line?
  96.  
  97. A route line can have 4 arguments on the line.  The first two are
  98. mandatory, but the last two are not.
  99.  
  100. The first argument is the filename pattern.  This is the filename as it
  101. appears in your PACKETS directory.  Each name in this field should end
  102. with a #? unless you are wanting to specify the whole filename.  This
  103. field uses full AmigaDos2.0 pattern matching.  This can get really
  104. powerful and complicated, so you may want to read your AmigaDos manual
  105. for some hints on using strange patterns.
  106.  
  107. The Second Argument, is the Xferq.Library compatible address that the
  108. file will be sent to.  This can be anything from a single number, which
  109. it will assume is another node in your Net (by using the defaults in
  110. your "HOST" keyword, and the Host address you have setup with Xferq
  111. itself), to a full 5d FTN address.
  112.  
  113. As of version 0.58 of JamScan, the destination address in the second
  114. argument is allowed to have wild cards.  Any of the numeric fields can
  115. be replaced by an * character (only an * character, not any other wild
  116. card character).  This allows JamScan to require a much smaller config
  117. file and doesn't require you to add a configuration line for every single
  118. system you might want to send mail to.
  119.  
  120. You can also put a Non-Fidonet address type in this field, and it will
  121. work fine.
  122.  
  123. The last two fields are the Archiver type and the priority.  The defaults
  124. are the "Lha" archiver, and a "Norm" priority setting.  Either or both
  125. of these two settings can be left out, and they can be in either order.
  126.  
  127. The outbound compressors supported are "Lha", "Lzh", "Arc", "Zoo", and
  128. "Zip".  A setting of "Non" is also partially supported, but not fully
  129. working (as it isn't something people use often so wasn't a high priority).
  130.  
  131. Also, if one of these two fields is found to be a number (non-0 value)
  132. then this number will be used directly as the priority that the files
  133. will be sent with.
  134.  
  135.  
  136. Example Config File:
  137.  
  138. ; Your Host Address (2d is required, any extra is allowed)
  139. HOST 1:163/139
  140.  
  141. ; Settings for the default priorities
  142. HOLD -50
  143. DIRECT 30
  144. CRASH 50
  145.  
  146. ; Directory where outbound bundles will be put.
  147. BUNDLES outbound:
  148.  
  149. ; Directory to search for outbound files
  150. PACKETS outbound:
  151.  
  152. ; Directory root used to create temporary compression directories
  153. PKTS outbound:packets/
  154.  
  155. route 1.167.#?         ZyXELNET#18:110/0.0   lzh norm
  156.  
  157. route #?.163.?11.#?    FidoNet#18:163/311.0  lzh crash
  158.  
  159. route 2.#?             ZyXELNET#16:16/0.0    lzh norm
  160. route 16.#?            ZyXELNET#16:16/0.0    lzh norm
  161. route 17.#?            ZyXELNET#16:16/0.0    lzh norm
  162.  
  163. route 19.#?            ZyXELNET#18:25/0.0    lzh norm
  164.  
  165. route 18.21.#?         FidoNet#18:21/0.0     lzh norm
  166. route 1.2402.#?        FidoNet#18:21/0.0     lzh norm
  167.  
  168. route 18.24.#?         FidoNet#18:24/0.0     lzh norm
  169. route 1.121.#?         FidoNet#18:24/0.0     lzh norm
  170.  
  171. route 18.26.#?         FidoNet#18:26/0.0     lzh norm
  172. route 1.260.#?         FidoNet#18:26/0.0     lzh norm
  173.  
  174. route 18.#?            ZyXELNET#*:*/*.0      lzh norm
  175.  
  176.  
  177. route 1.163.1?9.38.#?  FidoNet#1:163/109.38  lzh crash
  178. route 1.163.1?9.4.#?   FidoNet#1:163/139.4   lzh crash
  179.  
  180. route 1.163.109.#?     FidoNet#1:163/109.0   lzh crash
  181. route 1.163.13(3|4).#? FidoNet#1:163/134.0   lzh crash
  182. route 1.163.139.8.#?   FidoNet#1:163/139.8   lzh hold
  183.  
  184. route 1.163.#?         FidoNet#*:*/*.0       lzh crash
  185. route 1.243.#?         FidoNet#*:*/*.0       lzh crash
  186.  
  187. route (1|2|3|4|5|6).#? FidoNet#*:*/*.0       lzh direct
  188.  
  189. route 40.553.#?        AmigaNet#*:*/*.0      lzh crash
  190. route 40.#?            AmigaNet#*:*/*.0      lzh direct
  191.  
  192.  
  193.  
  194. History:
  195.  
  196. 0.54 - initial release, October 4
  197.  
  198. 0.55 - minor tweeks, October 16
  199.  
  200. 0.56 - Adding support for converting .FLO files. (not finished)
  201.  
  202. February 94
  203. 0.57 - Raised number of route lines to 200 (the limit of 50 had been hit)
  204.        Changed to SAS 6.3 from Lattice 5.10b
  205.  
  206. March 94
  207. 0.58 - Adding pattern matching ability to destination address field
  208.        "*" is the pattern.
  209.        Back to Lattice 5.10b :-(
  210.